get /recommendations
Get sizing recommendations for a VM (getRecommendationsForVm)
Gets sizing recommendations for a VM.
Consumes
This API call consumes the following media types via the Content-Type request header:
- application/json
Query parameters
vmId (required)
Path Parameter — Virtual machine ID
ceId (required)
Path Parameter — Cloud Extension ID
Return type
PerformanceOptimized (optional)
array[VmProvisioningInfo] (optional)
vmName (optional) |
String |
cpuCount (optional) |
Integer |
memorySizeGB (optional) |
Double format: double |
diskCount (optional) |
Integer |
osName (optional) |
Integer |
osId (optional) |
String |
array[RecommendedInstance] (optional)
instanceName (optional) |
String |
cpuCount (optional) |
Integer |
memoryGB (optional) |
Double format: double |
hourlyCost (optional) |
Double format: double |
_type |
StringAWS or Azure Enum: RecommendedAWSInstance RecommendedAzureInstance RecommendedGcpInstance |
costOptimized (optional)
array[VmUsageInfo] (optional)
monitoringStartDate (optional) |
Datedate when monitoring started format: date-time |
historicalDayCount (optional) |
Double format: double |
cpuUsage (optional) |
Double format: double |
memoryUsageGB (optional) |
Double format: double |
array[RecommendedInstance] (optional)
instanceName (optional) |
String |
cpuCount (optional) |
Integer |
memoryGB (optional) |
Double format: double |
hourlyCost (optional) |
Double format: double |
_type |
StringAWS or Azure Enum: RecommendedAWSInstance RecommendedAzureInstance RecommendedGcpInstance |
Example data
Content-Type: application/json
{
"performanceOptimized" :{
"vmProvisioningInfo" :{
"vmName" : "aeiou",
"memorySizeGB" : 6.027456183070403,
"osId" : "aeiou",
"diskCount" : 1,
"osName" : "aeiou",
"cpuCount" : 0
},
"recommendedInstances" :[{
"instanceName" : "aeiou",
"hourlyCost" : 2.3021358869347655,
"_type" : "RecommendedAwsInstance",
"memoryGB" : 5.637376656633329,
"cpuCount" : 5
} ]
},
"costOptimized" :{
"vmUsageInfo" : {
"cpuUsage" : 9.301444243932576,
"monitoringStartDate" : "2000-01-23T04:56:07.000+00:00",
"historicalDayCount" 7.061401241503109,
"memoryUsageGB" : 3.616076749251911
},
"recommendedInstances": [""]
}
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
- application/json
Responses
200
OK
Default
Error ErrorInfo
errorCode (optional) |
String |
url(optional) |
String |
message (optional) |
String |